/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
    \\  /    A nd           | Copyright (C) 2019 Synthetik Applied Technologies
     \\/     M anipulation  |
-------------------------------------------------------------------------------
License
    This file is derivative work of OpenFOAM.

    OpenFOAM is free software: you can redistribute it and/or modify it
    under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    for more details.

    You should have received a copy of the GNU General Public License
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.

Class
    Foam::reactionRates::pressureBasedRateActivation

Description
    pressureBased reaction rate

SourceFiles
    pressureBasedReactionRate.C

\*---------------------------------------------------------------------------*/

#ifndef pressureBasedReactionRate_H
#define pressureBasedReactionRate_H

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

#include "reactionRate.H"

namespace Foam
{
namespace reactionRates
{

/*---------------------------------------------------------------------------*\
                    Class pressureBased Declaration
\*---------------------------------------------------------------------------*/

class pressureBased
:
    public reactionRate
{
// Private data

    //- Pressure scaling coefficient
    scalar pScale_;

    //- Pressure exponent
    dimensionedScalar pExponent_;

    //- Pressure coefficient
    dimensionedScalar pCoeff_;

    //- Rate offset
    dimensionedScalar offset_;

public:

    //- Runtime type information
    TypeName("pressureBased");

    // Constructor
    pressureBased(const fvMesh& mesh, const dictionary& dict);


    //- Destructor
    virtual ~pressureBased();

    //- Construct and return a clone
    virtual autoPtr<reactionRate> clone() const
    {
        const pressureBased& pbrr(*this);
        return autoPtr<reactionRate>(new pressureBased(pbrr));
    }



    // Public functions

        //- Cell based reaction rate
        virtual scalar k
        (
            const scalar p,
            const scalar T,
            const label celli
        ) const;

        //- Reaction rate
        virtual tmp<volScalarField> k
        (
            const volScalarField& p,
            const volScalarField& T
        ) const;
};


// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

} // End namespace reactionRates
} // End namespace Foam

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

#endif

// ************************************************************************* //
